Network Events API
How to use the API
The table below outlines how different parts of the Network Events API operate, and how each part can be used.
API Function | How it works | What it can be used for |
Retrieve events | The Service Provider is identified from the clientโs credentials. Events which impact services owned by the Service Provider are then retrieved, with optional search parameters able to refine the list. |
Allows the Service Provider to:
|
Retrieve event detail | Retrieves the full event details for a given event. | Allows the Service Provider to retrieve all event information for a given event. |
Retrieve impacts | Retrieves all services which are owned by a Service Provider and are impacted by a given event. | Allows the Service Provider to export a list of services impacted by a defined event. |